<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Marker Support</title>
<style type="text/css">@import url("file:/home/moovida/rcpdevelopment/eclipse/configuration/org.eclipse.osgi/bundles/488/1/.cp/book.css");</style>
<style type="text/css">@import url("file:/home/moovida/rcpdevelopment/eclipse/configuration/org.eclipse.osgi/bundles/505/1/.cp/schema.css");</style>
</HEAD>
<BODY>
<H1 style="text-align:center">Marker Support</H1>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.ui.ide.markerSupport<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>3.2
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>The Marker Support extension point defines extensions to the workbench tools that show markers such as the problems, bookmarks and tasks views.<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
<p></p>
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.problemFilter">problemFilter</a>* , <a href="#e.markerTypeCategory">markerTypeCategory</a>* , <a href="#e.markerGrouping">markerGrouping</a>* , <a href="#e.markerGroupingEntry">markerGroupingEntry</a>* , <a href="#e.markerAttributeGrouping">markerAttributeGrouping</a>* , <a href="#e.markerContentGenerator">markerContentGenerator</a>* , <a href="#e.markerField">markerField</a>* , <a href="#e.markerContentGeneratorExtension">markerContentGeneratorExtension</a>*)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST extension</p>
<p class="code SchemaDtdAttlist">point&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.problemFilter">problemFilter</a> (<a href="#e.selectedType">selectedType</a>)*&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST problemFilter</p>
<p class="code SchemaDtdAttlist">enabled&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(true | false) </p><p class="code SchemaDtdAttlist">scope&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(ON_ANY|ON_SELECTED_ONLY|ON_SELECTED_AND_CHILDREN|ON_ANY_IN_SAME_CONTAINER) </p><p class="code SchemaDtdAttlist">onDescription&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">severity&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(ERROR|WARNING|INFO) </p><p class="code SchemaDtdAttlist">name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
A problem filter is a filter that can be applied to the problems view.
@deprecated in 3.4. Use markerFieldConfiguration and bind it to the markerContentGenerator you specify.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>enabled</b> - Whether or not this filter is enabled by default. If this value is not specified the value is true.</li>
<li><b>scope</b> - The scope of the filter. One of 
ON_ANY: any item in the workbench
ON_SELECTED_ONLY: on the currently selected item
ON_SELECTED_AND_CHILDREN: on the currently selected item and it's children
ON_ANY_IN_SAME_CONTAINER: on any item with the same top level container as the selection</li>
<li><b>onDescription</b> - The description of the problem to check against. If this value is preceded with a ! the check will check that the description does not contain this string.</li>
<li><b>severity</b> - The severity of problem this filter is enabled for. If this value is not set then no filtering by severity will occur. Severity can be one of the following values: ERROR, WARNING or INFO.</li>
<li><b>name</b> - The human readable name of the filter.</li>
<li><b>id</b> - The unique id of the filter.</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.selectedType">selectedType</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST selectedType</p>
<p class="code SchemaDtdAttlist">markerId&nbsp;IDREF #IMPLIED</p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
The selectedTypes are the ids of the marker types selected by default in this filter. If there are no selected types all marker types are enabled. All types not specified in this filter are disabled by default.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>markerId</b> - The id of a marker that is enabled by default.</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.markerTypeCategory">markerTypeCategory</a> (<a href="#e.markerTypeReference">markerTypeReference</a>)+&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST markerTypeCategory</p>
<p class="code SchemaDtdAttlist">name&nbsp;CDATA #REQUIRED</p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
The markerTypeCategory is an element for grouping marker types into a single category.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>name</b> - The label is the human readable name that will be presented to the user.</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.markerTypeReference">markerTypeReference</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST markerTypeReference</p>
<p class="code SchemaDtdAttlist">id&nbsp;IDREF #REQUIRED</p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
The markerTypeReference is a reference to a markerType defined using the extension point in org.eclipse.core.resources.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>id</b> - The id of the markerType</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.markerAttributeGrouping">markerAttributeGrouping</a> (<a href="#e.markerAttributeMapping">markerAttributeMapping</a>*)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST markerAttributeGrouping</p>
<p class="code SchemaDtdAttlist">markerType&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;IDREF #REQUIRED</p><p class="code SchemaDtdAttlist">attribute&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">defaultGroupingEntry&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
markerAttributeGrouping is a definition of attribute mappings for a particular markerType.

markerAttributeGroupings defined at the top level are only applied to the problems view for compatibility with the pre 3.4 API.

It is generally recommended that a markerAttributeGrouping is defined as a child element of a markerGroup.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>markerType</b> - The id of the markerType this grouping applies to.</li>
<li><b>attribute</b> - The attribute is the name of the attribute to test. If it is not specified then only the defaultGroupingEntry will be checked.</li>
<li><b>defaultGroupingEntry</b> - The defaultGroupingEntry is the optional category for groupings that do not satisfy any of the markerAttributeMappings in the receiver. This default will be applied when the attribute value does not match a mapping or when the attribute is not available.</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.markerGrouping">markerGrouping</a> (<a href="#e.markerGroupingEntry">markerGroupingEntry</a> , <a href="#e.markerAttributeGrouping">markerAttributeGrouping</a>*)*&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST markerGrouping</p>
<p class="code SchemaDtdAttlist">label&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
A markerGrouping is a definition of a grouping criterea for the marker views that support it . 

Top level markerGroupings are assumed to belong to the problems content generator.

A markerGrouping is usually specified as the child of a markerContentGenerator. It is recommended that a markerContentGenerator defines it's own markerGroupings if possible.

Note that only the problems view supported markerGroupings pre 3.4.

If a markerGrouping has id org.eclipse.ui.ide.types the internal types marker grouping will be used.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>label</b> - The label is the human readable String that will be used to create the entry in the Group By-> menu for this marker grouping.</li>
<li><b>id</b> - The id is non translatable identifier for the markerGrouping. Referred to in a markerGroupingEntry.</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.markerAttributeMapping">markerAttributeMapping</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST markerAttributeMapping</p>
<p class="code SchemaDtdAttlist">value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">markerGroupingEntry&nbsp;CDATA #REQUIRED</p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
A markerAttributeMapping maps a marker attribute to a name.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>value</b> - The value is the value of the attribute that is used in this mapping.</li>
<li><b>markerGroupingEntry</b> - The id of the markerGroupingEntry that this attribute value maps to.</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.markerGroupingEntry">markerGroupingEntry</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST markerGroupingEntry</p>
<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">markerGrouping&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">label&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">priority&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
A markerGroupingEntry is the specification of one of the entries in a markerGrouping. A top level markerGroupingEntry can only be applied to a top level markerGrouping for compatibility with the pre 3.4 API.

It is recommended that a markerGroupingEntry is specified as a child element of a markerGrouping.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>id</b> - The id of the markerGroupingEntry. Referred to in a markerAttributeGrouping.</li>
<li><b>markerGrouping</b> - The markerGrouping is the id of the markerGrouping this entry will be added to.

This attribute is optional if this is defined as a child element of a markerGrouping.</li>
<li><b>label</b> - The translable label of the entry.</li>
<li><b>priority</b> - The priority of the entry. Higher priorities show up higher in the list.</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.markerContentGenerator">markerContentGenerator</a> (<a href="#e.markerFieldReference">markerFieldReference</a>+ , <a href="#e.markerTypeReference">markerTypeReference</a>+ , <a href="#e.markerFieldConfiguration">markerFieldConfiguration</a>* , <a href="#e.markerGrouping">markerGrouping</a>*)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST markerContentGenerator</p>
<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">defaultMarkerGrouping&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
A markerContentGenerator is the definition of a marker content for an instance of org.eclipse.ui.views.markers.MarkerSupportView.

 This element is EXPERIMENTAL and subject to change without notice.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>id</b> - The id attribute is the unique id of the markerContentGenerator.</li>
<li><b>name</b> - The name attribute is the human readable name of the content generator.</li>
<li><b>defaultMarkerGrouping</b> - defaultMarkerGrouping is the id of the grouping to use by default. This grouping must be defined as child element of the markerContentGenerator</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.markerField">markerField</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST markerField</p>
<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">class&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">icon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">filterClass&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">filterConfigurationClass&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
A markerField is the definition of a org.eclipse.ui.views.markers.MarkerField used to define a column</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>id</b> - The unique id of the field</li>
<li><b>class</b> - The class is the type used to instantiate the field.</li>
<li><b>name</b> - The name is the human readable name of the field.</li>
<li><b>icon</b> - The icon is the plug-in relative path for the icon.</li>
<li><b>filterClass</b> - The filterClass is the class that does filtering on this field when enabled. If this is not specified no filtering will occur based on this field.</li>
<li><b>filterConfigurationClass</b> - The filterConfigurationClass is an optional area that is used for configuration of the field in a filter dialog.</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.markerFieldReference">markerFieldReference</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST markerFieldReference</p>
<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;IDREF #REQUIRED</p><p class="code SchemaDtdAttlist">visible&nbsp;(true | false) </p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
A markerFieldReference is a reference to a markerField in a markerContentGenerator. The columns in a markersView are created in the order that the markerFieldReferences are specified. This is also the default sortOrder for the fields.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>id</b> - The id is the id of the markerField being referred to.</li>
<li><b>visible</b> - The visible flag indicates whether or not the receiver is visible. If this flag is not set the value is true.</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.markerFieldConfiguration">markerFieldConfiguration</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST markerFieldConfiguration</p>
<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">name&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">values&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">scope&nbsp;&nbsp;&nbsp;(ON_ANY|ON_SELECTED_ONLY|ON_SELECTED_AND_CHILDREN|ON_ANY_IN_SAME_CONTAINER) </p><p class="code SchemaDtdAttlist">enabled&nbsp;(true | false) </p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
markerFieldConfiguration is a definition of a configuration to be added to a markerContentGenerator by default such as the All Errors configuration in the problems view.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>id</b> - The id of the grouping.</li>
<li><b>name</b> - The human readable name of the grouping.</li>
<li><b>values</b> - The values is a class that specifies the values that are to be set in the filterClass of a markerField for the enclosing markerContentGenerator.</li>
<li><b>scope</b> - The scope of the grouping 
One of 
ON_ANY: any item in the workbench
ON_SELECTED_ONLY: on the currently selected item
ON_SELECTED_AND_CHILDREN: on the currently selected item and it's children
ON_ANY_IN_SAME_CONTAINER: on any item with the same top level container as the selection.
If this value is not set the value is ON_ANY</li>
<li><b>enabled</b> - The enabled flag determines whether or not the receiver is on by default. If this value is not specified it is assumed to be true.</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.markerContentGeneratorExtension">markerContentGeneratorExtension</a> (<a href="#e.markerGrouping">markerGrouping</a>* , <a href="#e.markerFieldConfiguration">markerFieldConfiguration</a>*)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST markerContentGeneratorExtension</p>
<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">generatorId&nbsp;IDREF #REQUIRED</p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
A markerContentGeneratorExtension is an extension to an existing markerContentGenerator.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>id</b> - The id of the receiver</li>
<li><b>generatorId</b> - The id of the generator being extended</li>
</ul>
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6>The following is an example of a problem filter definition in the marker support. This example only shows java warnings on the selected element and it's children and filters out those with the String NON-NLS
<p>
<pre class="Example"><span class="code SchemaTag">
 &lt;extension point=</span><span class="code SchemaCstring">&quot;org.eclipse.ui.ide.markerSupport&quot;</span><span class="code SchemaTag">&gt;
  &lt;problemFilter
    name = </span><span class="code SchemaCstring">&quot;Warnings&quot;</span><span class="code SchemaTag">
    id = </span><span class="code SchemaCstring">&quot;org.eclipse.example.warningFilter&quot;</span><span class="code SchemaTag">
    enabled = </span><span class="code SchemaCstring">&quot;true&quot;</span><span class="code SchemaTag">
    scope=</span><span class="code SchemaCstring">&quot;ON_SELECTED_AND_CHILDREN&quot;</span><span class="code SchemaTag">
    onDescription=</span><span class="code SchemaCstring">&quot;!NON-NLS&quot;</span><span class="code SchemaTag">
    severity=</span><span class="code SchemaCstring">&quot;WARNING&quot;</span><span class="code SchemaTag">
  &gt;
  &lt;selectedType
    markerId=</span><span class="code SchemaCstring">&quot;org.eclipse.core.resources.problemmarker&quot;</span><span class="code SchemaTag">/&gt;
  &lt;/problemFilter&gt;
 &lt;/extension&gt;
</span></pre>
</p>
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>The severity markerGrouping is provided in the org.eclipse.ui.ide plug-in by default.
<p></p>

<br>
<p class="note SchemaCopyright">
Copyright (c) 2005, 2007 IBM Corporation and others.<br>
All rights reserved. This program and the accompanying materials are made
available under the terms of the Eclipse Public License v1.0 which accompanies
this distribution, and is available at <a 
href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>

</p>
</BODY>
</HTML>
